/**
 * Copyright 2011 Joao Miguel Pereira
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package eu.jpereira.trainings.designpatterns.behavioral.state.appliance.snapshot;

/**
 * Originator objects will implement this interface. Implementing this interface
 * will provide a way to record it's internal state into a {@link Snapshot}
 * 
 * @author jpereira
 * 
 */
public interface Snapshotable {

	/**
	 * Create a new {@link Snapshot} with internal state
	 * 
	 * @return an {@link Snapshot}
	 */
	Snapshot takeSnapshot();

	/**
	 * Restore intenal state of {@link Snapshotable} with an instance of
	 * {@link Snapshot}
	 * 
	 * @param snapshot
	 *            The snapshot from internal state will be read
	 */
	void restoreFromSnapshot(Snapshot snapshot);

}
